<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
  <bookinfo>
    <title>Camel Reference Manual</title>
    <copyright>
      <year>2000-2008</year>
      <holder>Novell, Inc.</holder>
    </copyright>

    <legalnotice>
      <para>Permission is granted to make and distribute verbatim
      copies of this manual provided the copyright notice and this
      permission notice are preserved on all copies.</para>
      <para>Permission is granted to copy and distribute modified
      versions of this manual under the conditions for verbatim
      copying, provided also that the entire resulting derived work is
      distributed under the terms of a permission notice identical to
      this one.</para>
      <para>Permission is granted to copy and distribute translations
      of this manual into another language, under the above conditions
      for modified versions.</para>
    </legalnotice>

    <abstract>
      <para>This manual documents the interfaces of the Camel
      library @PROJECT_VERSION@.</para>
    </abstract>
  </bookinfo>

  <part id="api">
    <title>API Reference</title>

    <chapter id="Fundamentals">
      <title>Fundamentals</title>
      <xi:include href="xml/camel.xml"/>
      <xi:include href="xml/camel-debug.xml"/>
      <xi:include href="xml/camel-enums.xml"/>
      <xi:include href="xml/camel-object.xml"/>
      <xi:include href="xml/camel-object-bag.xml"/>
      <xi:include href="xml/camel-operation.xml"/>
      <xi:include href="xml/camel-url.xml"/>
      <xi:include href="xml/camel-weak-ref-group.xml"/>
    </chapter>

    <chapter id="Streams">
      <title>Streams</title>
      <xi:include href="xml/camel-stream.xml"/>
      <xi:include href="xml/camel-stream-buffer.xml"/>
      <xi:include href="xml/camel-stream-filter.xml"/>
      <xi:include href="xml/camel-stream-fs.xml"/>
      <xi:include href="xml/camel-stream-mem.xml"/>
      <xi:include href="xml/camel-stream-null.xml"/>
      <xi:include href="xml/camel-stream-process.xml"/>
      <xi:include href="xml/camel-filter-input-stream.xml"/>
      <xi:include href="xml/camel-filter-output-stream.xml"/>
      <xi:include href="xml/camel-null-output-stream.xml"/>
    </chapter>

    <chapter id="Stream-Filters">
      <title>Stream Filters</title>
      <xi:include href="xml/camel-mime-filter.xml"/>
      <xi:include href="xml/camel-mime-filter-basic.xml"/>
      <xi:include href="xml/camel-mime-filter-bestenc.xml"/>
      <xi:include href="xml/camel-mime-filter-canon.xml"/>
      <xi:include href="xml/camel-mime-filter-charset.xml"/>
      <xi:include href="xml/camel-mime-filter-crlf.xml"/>
      <xi:include href="xml/camel-mime-filter-enriched.xml"/>
      <xi:include href="xml/camel-mime-filter-from.xml"/>
      <xi:include href="xml/camel-mime-filter-gzip.xml"/>
      <xi:include href="xml/camel-mime-filter-html.xml"/>
      <xi:include href="xml/camel-mime-filter-index.xml"/>
      <xi:include href="xml/camel-mime-filter-linewrap.xml"/>
      <xi:include href="xml/camel-mime-filter-pgp.xml"/>
      <xi:include href="xml/camel-mime-filter-progress.xml"/>
      <xi:include href="xml/camel-mime-filter-tohtml.xml"/>
      <xi:include href="xml/camel-mime-filter-windows.xml"/>
      <xi:include href="xml/camel-mime-filter-yenc.xml"/>
    </chapter>

    <chapter id="Services">
      <title>Services</title>
      <xi:include href="xml/camel-session.xml"/>
      <xi:include href="xml/camel-provider.xml"/>
      <xi:include href="xml/camel-service.xml"/>
      <xi:include href="xml/camel-network-service.xml"/>
      <xi:include href="xml/camel-store.xml"/>
      <xi:include href="xml/camel-subscribable.xml"/>
      <xi:include href="xml/camel-store-summary.xml"/>
      <xi:include href="xml/camel-offline-store.xml"/>
      <xi:include href="xml/camel-transport.xml"/>
      <xi:include href="xml/camel-settings.xml"/>
      <xi:include href="xml/camel-network-settings.xml"/>
      <xi:include href="xml/camel-store-settings.xml"/>
      <xi:include href="xml/camel-local-settings.xml"/>
      <xi:include href="xml/camel-offline-settings.xml"/>
    </chapter>

    <chapter id="Filters">
      <title>Filters</title>
      <xi:include href="xml/camel-filter-driver.xml"/>
      <xi:include href="xml/camel-filter-search.xml"/>
      <xi:include href="xml/camel-junk-filter.xml"/>
    </chapter>

    <chapter id="Folders">
      <title>Folders</title>
      <xi:include href="xml/camel-folder.xml"/>
      <xi:include href="xml/camel-folder-search.xml"/>
      <xi:include href="xml/camel-folder-summary.xml"/>
      <xi:include href="xml/camel-folder-thread.xml"/>
      <xi:include href="xml/camel-message-info.xml"/>
      <xi:include href="xml/camel-message-info-base.xml"/>
      <xi:include href="xml/camel-offline-folder.xml"/>
    </chapter>

    <chapter id="Virtual-Folders">
      <title>Virtual ("Search") Folders</title>
      <xi:include href="xml/camel-vee-folder.xml"/>
      <xi:include href="xml/camel-vee-message-info.xml"/>
      <xi:include href="xml/camel-vee-store.xml"/>
      <xi:include href="xml/camel-vee-summary.xml"/>
      <xi:include href="xml/camel-vtrash-folder.xml"/>
      <xi:include href="xml/camel-vee-data-cache.xml"/>
    </chapter>

    <chapter id="Addresses">
      <title>Addresses</title>
      <xi:include href="xml/camel-address.xml"/>
      <xi:include href="xml/camel-internet-address.xml"/>
      <xi:include href="xml/camel-nntp-address.xml"/>
    </chapter>

    <chapter id="Crypto">
      <title>Crypto Contexts</title>
      <xi:include href="xml/camel-cipher-context.xml"/>
      <xi:include href="xml/camel-gpg-context.xml"/>
      <xi:include href="xml/camel-smime-context.xml"/>

      <xi:include href="xml/camel-sasl.xml"/>
      <xi:include href="xml/camel-sasl-anonymous.xml"/>
      <xi:include href="xml/camel-sasl-cram-md5.xml"/>
      <xi:include href="xml/camel-sasl-digest-md5.xml"/>
      <xi:include href="xml/camel-sasl-gssapi.xml"/>
      <xi:include href="xml/camel-sasl-login.xml"/>
      <xi:include href="xml/camel-sasl-ntlm.xml"/>
      <xi:include href="xml/camel-sasl-plain.xml"/>
      <xi:include href="xml/camel-sasl-popb4smtp.xml"/>
      <xi:include href="xml/camel-sasl-xoauth2.xml"/>
      <xi:include href="xml/camel-sasl-xoauth2-google.xml"/>
      <xi:include href="xml/camel-sasl-xoauth2-outlook.xml"/>
      <xi:include href="xml/camel-sasl-xoauth2-yahoo.xml"/>
    </chapter>

    <chapter id="MIME">
      <title>MIME Objects</title>
      <xi:include href="xml/camel-data-wrapper.xml"/>
      <xi:include href="xml/camel-medium.xml"/>
      <xi:include href="xml/camel-mime-part.xml"/>
      <xi:include href="xml/camel-multipart.xml"/>
      <xi:include href="xml/camel-multipart-signed.xml"/>
      <xi:include href="xml/camel-multipart-encrypted.xml"/>
      <xi:include href="xml/camel-mime-message.xml"/>
      <xi:include href="xml/camel-mime-parser.xml"/>
    </chapter>

    <chapter id="Storage">
      <title>Metadata Storage</title>
      <xi:include href="xml/camel-block-file.xml"/>
      <xi:include href="xml/camel-certdb.xml"/>
      <xi:include href="xml/camel-data-cache.xml"/>
      <xi:include href="xml/camel-db.xml"/>
      <xi:include href="xml/camel-index.xml"/>
      <xi:include href="xml/camel-partition-table.xml"/>
      <xi:include href="xml/camel-text-index.xml"/>
    </chapter>

    <chapter id="Utilities">
      <title>Utilities</title>
      <xi:include href="xml/camel-async-closure.xml"/>
      <xi:include href="xml/camel-charset-map.xml"/>
      <xi:include href="xml/camel-file-utils.xml"/>
      <xi:include href="xml/camel-html-parser.xml"/>
      <xi:include href="xml/camel-hostname-utils.xml"/>
      <xi:include href="xml/camel-iconv.xml"/>
      <xi:include href="xml/camel-lock.xml"/>
      <xi:include href="xml/camel-lock-client.xml"/>
      <xi:include href="xml/camel-lock-helper.xml"/>
      <xi:include href="xml/camel-memchunk.xml"/>
      <xi:include href="xml/camel-mempool.xml"/>
      <xi:include href="xml/camel-mime-utils.xml"/>
      <xi:include href="xml/camel-mime-part-utils.xml"/>
      <xi:include href="xml/camel-movemail.xml"/>
      <xi:include href="xml/camel-msgport.xml"/>
      <xi:include href="xml/camel-name-value-array.xml"/>
      <xi:include href="xml/camel-named-flags.xml"/>
      <xi:include href="xml/camel-net-utils.xml"/>
      <xi:include href="xml/camel-search-sql-sexp.xml"/>
      <xi:include href="xml/camel-sexp.xml"/>
      <xi:include href="xml/camel-string-utils.xml"/>
      <xi:include href="xml/camel-trie.xml"/>
      <xi:include href="xml/camel-uid-cache.xml"/>
      <xi:include href="xml/camel-url-scanner.xml"/>
      <xi:include href="xml/camel-utf8.xml"/>
      <xi:include href="xml/camel-utils.xml"/>
    </chapter>

  </part>

  <part id="services">
    <title>Built-in Services</title>

    <chapter id="Local">
      <title>Local Services</title>
      <xi:include href="xml/camel-local-folder.xml"/>
      <xi:include href="xml/camel-local-store.xml"/>
      <xi:include href="xml/camel-local-summary.xml"/>
      <xi:include href="xml/camel-maildir-folder.xml"/>
      <xi:include href="xml/camel-maildir-message-info.xml"/>
      <xi:include href="xml/camel-maildir-store.xml"/>
      <xi:include href="xml/camel-maildir-summary.xml"/>
      <xi:include href="xml/camel-mbox-folder.xml"/>
      <xi:include href="xml/camel-mbox-message-info.xml"/>
      <xi:include href="xml/camel-mbox-store.xml"/>
      <xi:include href="xml/camel-mbox-summary.xml"/>
      <xi:include href="xml/camel-mh-folder.xml"/>
      <xi:include href="xml/camel-mh-settings.xml"/>
      <xi:include href="xml/camel-mh-store.xml"/>
      <xi:include href="xml/camel-mh-summary.xml"/>
      <xi:include href="xml/camel-spool-folder.xml"/>
      <xi:include href="xml/camel-spool-settings.xml"/>
      <xi:include href="xml/camel-spool-store.xml"/>
      <xi:include href="xml/camel-spool-summary.xml"/>
    </chapter>

    <chapter id="IMAP">
      <title>IMAP Service</title>
      <xi:include href="xml/camel-imapx-command.xml"/>
      <xi:include href="xml/camel-imapx-conn-manager.xml"/>
      <xi:include href="xml/camel-imapx-folder.xml"/>
      <xi:include href="xml/camel-imapx-input-stream.xml"/>
      <xi:include href="xml/camel-imapx-job.xml"/>
      <xi:include href="xml/camel-imapx-logger.xml"/>
      <xi:include href="xml/camel-imapx-mailbox.xml"/>
      <xi:include href="xml/camel-imapx-message-info.xml"/>
      <xi:include href="xml/camel-imapx-namespace.xml"/>
      <xi:include href="xml/camel-imapx-namespace-response.xml"/>
      <xi:include href="xml/camel-imapx-search.xml"/>
      <xi:include href="xml/camel-imapx-server.xml"/>
      <xi:include href="xml/camel-imapx-settings.xml"/>
      <xi:include href="xml/camel-imapx-store.xml"/>
      <xi:include href="xml/camel-imapx-store-summary.xml"/>
      <xi:include href="xml/camel-imapx-summary.xml"/>
      <xi:include href="xml/camel-imapx-list-response.xml"/>
      <xi:include href="xml/camel-imapx-status-response.xml"/>
    </chapter>

    <chapter id="NNTP">
      <title>NNTP Service</title>
      <xi:include href="xml/camel-nntp-folder.xml"/>
      <xi:include href="xml/camel-nntp-settings.xml"/>
      <xi:include href="xml/camel-nntp-store.xml"/>
      <xi:include href="xml/camel-nntp-store-summary.xml"/>
      <xi:include href="xml/camel-nntp-stream.xml"/>
      <xi:include href="xml/camel-nntp-summary.xml"/>
    </chapter>

    <chapter id="POP">
      <title>POP3 Service</title>
      <xi:include href="xml/camel-pop3-engine.xml"/>
      <xi:include href="xml/camel-pop3-folder.xml"/>
      <xi:include href="xml/camel-pop3-settings.xml"/>
      <xi:include href="xml/camel-pop3-store.xml"/>
      <xi:include href="xml/camel-pop3-stream.xml"/>
    </chapter>

    <chapter id="Sendmail">
      <title>Sendmail Service</title>
      <xi:include href="xml/camel-sendmail-settings.xml"/>
      <xi:include href="xml/camel-sendmail-transport.xml"/>
    </chapter>

    <chapter id="SMTP">
      <title>SMTP Service</title>
      <xi:include href="xml/camel-smtp-settings.xml"/>
      <xi:include href="xml/camel-smtp-transport.xml"/>
    </chapter>

  </part>

  <index id="api-index-full">
    <title>Index</title>
    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-deprecated" role="deprecated">
    <title>Index of deprecated symbols</title>
    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-50" role="3.50">
    <title>Index of new symbols in 3.50</title>
    <xi:include href="xml/api-index-3.50.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-46" role="3.46">
    <title>Index of new symbols in 3.46</title>
    <xi:include href="xml/api-index-3.46.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-44" role="3.44">
    <title>Index of new symbols in 3.44</title>
    <xi:include href="xml/api-index-3.44.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-42" role="3.42">
    <title>Index of new symbols in 3.42</title>
    <xi:include href="xml/api-index-3.42.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-40" role="3.40">
    <title>Index of new symbols in 3.40</title>
    <xi:include href="xml/api-index-3.40.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-38" role="3.38">
    <title>Index of new symbols in 3.38</title>
    <xi:include href="xml/api-index-3.38.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-36" role="3.36">
    <title>Index of new symbols in 3.36</title>
    <xi:include href="xml/api-index-3.36.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-34" role="3.34">
    <title>Index of new symbols in 3.34</title>
    <xi:include href="xml/api-index-3.34.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-32" role="3.32">
    <title>Index of new symbols in 3.32</title>
    <xi:include href="xml/api-index-3.32.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-30" role="3.30">
    <title>Index of new symbols in 3.30</title>
    <xi:include href="xml/api-index-3.30.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-28" role="3.28">
    <title>Index of new symbols in 3.28</title>
    <xi:include href="xml/api-index-3.28.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-26" role="3.26">
    <title>Index of new symbols in 3.26</title>
    <xi:include href="xml/api-index-3.26.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-24" role="3.24">
    <title>Index of new symbols in 3.24</title>
    <xi:include href="xml/api-index-3.24.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-22" role="3.22">
    <title>Index of new symbols in 3.22</title>
    <xi:include href="xml/api-index-3.22.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-20" role="3.20">
    <title>Index of new symbols in 3.20</title>
    <xi:include href="xml/api-index-3.20.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-18" role="3.18">
    <title>Index of new symbols in 3.18</title>
    <xi:include href="xml/api-index-3.18.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-16" role="3.16">
    <title>Index of new symbols in 3.16</title>
    <xi:include href="xml/api-index-3.16.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-12" role="3.12">
    <title>Index of new symbols in 3.12</title>
    <xi:include href="xml/api-index-3.12.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-10" role="3.10">
    <title>Index of new symbols in 3.10</title>
    <xi:include href="xml/api-index-3.10.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-8" role="3.8">
    <title>Index of new symbols in 3.8</title>
    <xi:include href="xml/api-index-3.8.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-6" role="3.6">
    <title>Index of new symbols in 3.6</title>
    <xi:include href="xml/api-index-3.6.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-4" role="3.4">
    <title>Index of new symbols in 3.4</title>
    <xi:include href="xml/api-index-3.4.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-2" role="3.2">
    <title>Index of new symbols in 3.2</title>
    <xi:include href="xml/api-index-3.2.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-3-0" role="3.0">
    <title>Index of new symbols in 3.0</title>
    <xi:include href="xml/api-index-3.0.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-2-32" role="2.32">
    <title>Index of new symbols in 2.32</title>
    <xi:include href="xml/api-index-2.32.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-2-30" role="2.30">
    <title>Index of new symbols in 2.30</title>
    <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-2-28" role="2.28">
    <title>Index of new symbols in 2.28</title>
    <xi:include href="xml/api-index-2.28.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-2-26" role="2.26">
    <title>Index of new symbols in 2.26</title>
    <xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-2-24" role="2.24">
    <title>Index of new symbols in 2.24</title>
    <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
  </index>
  <index id="api-index-2-22" role="2.22">
    <title>Index of new symbols in 2.22</title>
    <xi:include href="xml/api-index-2.22.xml"><xi:fallback /></xi:include>
  </index>

  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>

</book>
